// Copyright 2009-present MongoDB, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#include <mongocxx/index_model-fwd.hpp> // IWYU pragma: export

#include <bsoncxx/document/value.hpp>
#include <bsoncxx/document/view_or_value.hpp>

#include <mongocxx/options/index.hpp> // IWYU pragma: keep: backward compatibility, to be removed.

#include <mongocxx/config/prelude.hpp>

namespace mongocxx {
namespace v_noabi {

///
/// Used by @ref mongocxx::v_noabi::index_view.
///
class index_model {
   public:
    ///
    /// Initializes a new index_model over a mongocxx::v_noabi::collection.
    ///
    MONGOCXX_ABI_EXPORT_CDECL()
    index_model(
        bsoncxx::v_noabi::document::view_or_value const& keys,
        bsoncxx::v_noabi::document::view_or_value const& options = {});

    index_model() = delete;

    ///
    /// Move constructs an index_model.
    ///
    MONGOCXX_ABI_EXPORT_CDECL() index_model(index_model&&) noexcept;

    ///
    /// Move assigns an index_model.
    ///
    MONGOCXX_ABI_EXPORT_CDECL(index_model&) operator=(index_model&&) noexcept;

    ///
    /// Copy constructs an index_model.
    ///
    MONGOCXX_ABI_EXPORT_CDECL() index_model(index_model const&);

    ///
    /// Copy assigns an index_model.
    ///
    index_model& operator=(index_model const&) = default;

    ///
    /// Destroys an index_model.
    ///
    MONGOCXX_ABI_EXPORT_CDECL() ~index_model();

    ///
    /// Retrieves keys of an index_model.
    ///
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::document::view) keys() const;

    ///
    /// Retrieves options of an index_model.
    ///
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::document::view) options() const;

   private:
    bsoncxx::v_noabi::document::value _keys;
    bsoncxx::v_noabi::document::value _options;
};

} // namespace v_noabi
} // namespace mongocxx

#include <mongocxx/config/postlude.hpp>

///
/// @file
/// Provides @ref mongocxx::v_noabi::index_model.
///
